home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / wb-tools / extrainfo / extrawbinfo.doc < prev    next >
Text File  |  1995-07-19  |  11KB  |  404 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                              ExtraWBInfo.guide
  7.  
  8.  
  9.                                   Version
  10.                       ExtraWBInfo.guide 1.0 (24.6.95)
  11.  
  12.  
  13.  
  14.  
  15.                                 Simon Dick
  16.  
  17.  
  18.  
  19.                         1995 - Freely distributable
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                         Generated with Heddley v1.1
  37.                      Heddley v1.1 (C) Edd Dumbill 1994
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.                                 - Page 1 -
  77.  
  78.  
  79.  
  80. 1.    ExtraWBInfo manual
  81.  
  82.  
  83.  ********************************************************************
  84.  **************************** ExtraWBInfo ***************************
  85.  ********************************************************************
  86.  
  87.  
  88.                             By Simon Dick
  89.                              Version 1.0
  90.                             24th June 1995
  91.  
  92.  
  93.                          Distribution           
  94.                          Disclaimer               
  95.                          Contents               
  96.                          Requirements           
  97.                          Introduction           
  98.                          Installation           
  99.                          Tooltypes              
  100.                          Usage                  
  101.                          Credits                  
  102.                          History                  
  103.                          Author                   
  104.                          Bugs and Improvements  
  105.                          See ExtraInfo.guide    
  106.  
  107. 2.    Distribution
  108.  
  109.  
  110.   o ExtraWBInfo is Copyright ©1995 by Simon Dick.
  111.     All rights are reserved.
  112.  
  113.   o ExtraWBInfo is "freeware" so no donation is required. It is *not* in
  114.     the public domain.
  115.  
  116.   o ExtraWBInfo may be freely distributed provided all the files listed
  117.     in Contents remain unaltered and are included in the distribution.
  118.     They may, however, be archived to conserve space.
  119.  
  120.   o No profit is to be made by selling this software. You may only
  121.     charge  enough  to  cover  reasonable  production and distribution
  122.     costs.
  123.  
  124.   o This software may not be included in a commercial package, or on a
  125.     magazine coverdisk, without the author's written permission.
  126.  
  127.   o This software may not be uploaded onto any BBS that claims
  128.     copyright on uploaded material.
  129.  
  130.   o If you use ExtraWBInfo, I would enjoy receiving a postcard or email
  131.     from you. See my addresses.
  132.  
  133.          Amiga, AmigaDOS, AmigaGuide, Workbench and Kickstart
  134.           are registered trademarks of Commodore-Amiga, Inc.
  135.  
  136. 3.    Disclaimer
  137.  
  138.  
  139.  Disclaimer
  140.  ==========
  141.  
  142. This program is provided "as is" without warranty of any kind, either
  143. expressed or implied, including, but not limited to, the implied warranties
  144. of merchantability and fitness for a particular purpose. The entire risk as
  145. to the quality and performance of this program is with you. In no event can
  146.  
  147.                                 - Page 2 -
  148. 3.    Disclaimer
  149.  
  150. I be liable to you for damages of any kind arising out of the use of this
  151. program, or the inability to use it.
  152.  
  153. 4.    Contents
  154.  
  155.  
  156.  The following files should be in this distribution:
  157.  
  158.         ExtraWBInfo                     The actual program itself
  159.         ExtraWBInfo.info
  160.  
  161.         ExtraWBInfo.guide               The AmigaGuide version of this
  162.         ExtraWBInfo.guide.info          documentation
  163.  
  164.         ExtraWBInfo.doc                 The plain text version of this
  165.         ExtraWBInfo.doc.info            documentation
  166.  
  167. 5.    Requirements
  168.  
  169.  
  170.  ExtraWBInfo requires:
  171.  
  172.    · AmigaOS 3.0 / Kickstart V39 or higher
  173.    · commodities.library v36 or higher
  174.    · ExtraInfo v1.2 or higher
  175.  
  176. The following packages are optional:
  177.  
  178.    · SetMan
  179.    · PatchControl
  180.  
  181.    If you do not have either of the above two packages installed then you
  182. will not be able to quit ExtraWBInfo as it can be very unsafe to remove
  183. patches from the system. If you try to quit then the patch will just be
  184. disabled and the original function will be called.
  185.    On the other hand, if SetMan, PatchControl or some other compatible
  186. program has been installed then ExtraWBInfo is able to safely quit and will
  187. do so when asked.
  188.  
  189. 6.    Introduction
  190.  
  191.  
  192.  ExtraWBInfo is a program which replaces the Workbench Information window
  193. with ExtraInfo. It does this by patching the WBInfo() function, this means
  194. that it will only work under Workbench 3 or higher. There isn't any (legal)
  195. way to do this for Workbench 2.x though which means that ExtraWBInfo can
  196. only be used with Workbench 3 or higher.
  197.  
  198. 7.    Installation
  199.  
  200.  
  201.  There really isn't much to installing ExtraWBInfo, the best way of doing
  202. it is to simply drag the icon into your WBStartup drawer. The other way to
  203. do it is to copy it wherever you want and then add a line something like
  204. this to your S:User-Startup file:
  205.         Run >NIL: SYS:Utilities/ExtraWBInfo
  206.  
  207. If you use either of these methods, ExtraWBInfo will be run the next time
  208. you reboot.
  209.  
  210. 8.    Tooltypes
  211.  
  212.  
  213.  If you have got ExtraWBInfo being run from your User-Startup file then you
  214. (currently) haven't got any configuration options, this is one of the
  215. reasons that I recommend that you run ExtraWBInfo from your WBStartup
  216. drawer.
  217.  
  218.                                 - Page 3 -
  219. 8.    Tooltypes
  220.  
  221.  
  222. On the other hand, if run from Workbench, ExtraWBInfo recognises the
  223. following tooltype:
  224.  
  225.         EXTRAINFOCMD=<command>
  226.  
  227. Here is the description of the tooltype:
  228.  
  229.  EXTRAINFOCMD            String, default: "ExtraInfo"
  230.  
  231. This tooltype is to allow you to tell ExtraWBInfo where the actual
  232. ExtraInfo program is kept in your system, if this isn't given then
  233. ExtraWBInfo tries to run a program called ExtraInfo and just hopes that
  234. it's in your path.
  235.  
  236. 9.    Usage
  237.  
  238.  
  239.  Once you have ExtraWBInfo running, you don't really need to do anything
  240. else. As ExtraWBInfo runs as a commodity, you can use the commodities
  241. Exchange program supplied by CBM (or a replacement) to control ExtraWBInfo.
  242. If you disable ExtraWBInfo then the original WBInfo() function will be
  243. called.
  244.  
  245.  One note is that when run from ExtraWBInfo, ExtraInfo will read all of its
  246. configuration from its icons tooltypes. See the READICON argument in the
  247. ExtraInfo manual for more information.
  248.  
  249. NB ExtraWBInfo will only quit if SetMan or PatchControl are installed (see
  250. requirements for the reason), if neither are installed then when asked to
  251. quit, ExtraWBInfo will simply temporarily disable itself, you are then able
  252. to activate it again using Exchange.
  253.  
  254. 10.    Credits
  255.  
  256.  
  257.  Thanks must go to the following people:
  258.  
  259.  · Nick Christie for writing ExtraInfo in the first place
  260.  · O.I.C. for producing DICE v3 which was used to write this.
  261.  · And everyone who's still supporting the Amiga.
  262.  
  263. 11.    History
  264.  
  265.  39.3 (13.6.95) 4660 bytes
  266.  =========================
  267.  
  268.  · Removed support for all tooltypes except EXTRAINFOCMD, as ExtraWBInfo
  269.    now makes use of ExtraInfos READICON argument.
  270.  
  271.  39.2 (10.6.95) 5380 bytes
  272.  =========================
  273.  
  274.  · I forgot to include the GUIDENAME tooltype
  275.  · ExtraWBInfo now calls ExtraInfo using the short shell arguments
  276.  
  277.  39.1 (5.6.95) 5380 bytes
  278.  ========================
  279.  
  280.  · First Release
  281.  
  282. 12.    Author
  283.  
  284.  
  285.  ExtraWBInfo was written by:
  286.     Simon Dick
  287.  
  288.  
  289.                                 - Page 4 -
  290. 12.    Author
  291.  
  292. My address is:
  293.     31 Salisbury Road
  294.     Bexley
  295.     Kent DA5 3QE
  296.     England
  297.  
  298. My Email address is currently:
  299.     sidick@essex.ac.uk
  300.  
  301. ExtraWBInfo was developed on an 4MB A1200, 20MHz 68882, 428MB hard drive
  302. running Workbench 3.0 and was compiled using DICE V3.
  303.  
  304. If you have any suggestions, bug reports, questions, etc. then feel free to
  305. write to me. I will do my best to reply as long as you supply return
  306. postage (preferably IRC's).
  307.  
  308. 13.    Bugs And Future
  309.  
  310.  
  311.  Known Bugs
  312.  ==========
  313.  
  314.  · None currently known of.
  315.  
  316.  Possible improvements
  317.  =====================
  318.  
  319.  · Localise ExtraWBInfo.
  320.  · Possibly write a version for Kickstart 2.x. This would be purely a
  321.    hack though, but as it only has to work with a certain Kickstart then
  322.    there shouldn't be any problems.
  323.  · Add some sort of preference window instead of just having them set
  324.    using tooltypes.
  325.  · Keeping up to date with any future changes in ExtraInfo.
  326.  · Add some command line options.
  327.  · Only use ExtraInfo for certain tasks.
  328.  
  329. Any bug reports or suggestions for ExtraWBInfo should be sent to me.
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.                                 - Page 5 -
  361. 13.    Bugs And Future
  362.  
  363.  
  364. 14.    INDEX of sections
  365.  
  366. Author ..........................................................   3. 60
  367. Bugs And Future .................................................   4. 15
  368. Contents ........................................................   2.  2
  369. Credits .........................................................   3. 32
  370. Disclaimer ......................................................   1. 56
  371. Distribution ....................................................   1. 27
  372. ExtraWBInfo manual ..............................................   1.  0
  373. History .........................................................   3. 41
  374. Installation ....................................................   2. 47
  375. Introduction ....................................................   2. 38
  376. Requirements ....................................................   2. 16
  377. Tooltypes .......................................................   2. 59
  378. Usage ...........................................................   3. 14
  379.  
  380. 15.    INDEX of keywords
  381.  
  382.   Author                  .......................................   1. 24
  383.   Bugs and Improvements   .......................................   1. 25
  384.   Contents                .......................................   1. 16
  385.   Credits                 .......................................   1. 22
  386.   Disclaimer              .......................................   1. 15
  387.   Distribution            .......................................   1. 14
  388.   History                 .......................................   1. 23
  389.   Installation            .......................................   1. 19
  390.   Introduction            .......................................   1. 18
  391.   Requirements            .......................................   1. 17
  392.   See ExtraInfo.guide     .......................................   1. 26
  393.   Tooltypes               .......................................   1. 20
  394.   Usage                   .......................................   1. 21
  395. addresses .......................................................   1. 52
  396. Contents ........................................................   1. 38
  397. ExtraInfo .......................................................   2. 24
  398. ExtraInfo manual ................................................   3. 26
  399. me ..............................................................   4. 37
  400. Nick Christie ...................................................   3. 38
  401. S:User-Startup ..................................................   2. 54
  402. Simon Dick ......................................................   1. 31
  403. User-Startup ....................................................   2. 63
  404.